/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.uml_generator.manager;

import java.io.File;

import com.genia.toolbox.basics.exception.BundledException;
import com.genia.toolbox.uml_generator.bean.GenerationConfiguration;

/**
 * manager that allow the generation of java classes from XMI file.
 */
public interface UmlGeneratorManager
{

  /**
   * generate the java class from the UML modelisation.
   * 
   * @param configuration
   *          the configuration of the generation
   * @throws BundledException
   *           when an error occurred
   */
  public void generateModele(GenerationConfiguration configuration)
      throws BundledException;



  /**
   * return a {@link File} that is an UML model with all element tagged with
   * ignore tag.
   * 
   * @param model
   *          the model to transform
   * @return the transformed model
   * @throws BundledException
   *           when an error occurred
   */
  public File generateTemplateFromModele(File model)
      throws BundledException;



  /**
   * returns a xmi {@link File} extracted from a zargo {@link File}.
   * 
   * @param argoFile
   *          the UML modele from Argo UML.
   * @return the xmi {@link File} corresponding to the modele.
   * @throws BundledException
   *           when an error occurred
   */
  public File getXmiFileFromArgoFile(File argoFile)
      throws BundledException;



  /**
   * merge two models.
   * 
   * @param originalModel
   *          the model that will import the other model
   * @param mergedModel
   *          the model being imported
   * @return the merged model
   * @throws BundledException
   *           when an error occurred
   */
  public File mergeFile(final File originalModel, final File mergedModel)
      throws BundledException;

}
